home *** CD-ROM | disk | FTP | other *** search
/ BCI NET / BCI NET Dec 94.iso / archives / programming / libraries / muilist374.lha / mui-lists / mui-lists.readme < prev    next >
Encoding:
Text File  |  1994-08-29  |  6.2 KB  |  174 lines
  1.                              MUI-Lists
  2.  
  3.                          V37.4  -  28.8.1994
  4.  
  5.                        MUI Program Typing Aid
  6.  
  7.                         By M.J.Fisher © 1994
  8.  
  9.                            -  FreeWare -
  10.  
  11. Introduction
  12. ------------
  13. This  is a typing aid for programming with MUI. It is set up to work
  14. with  CED  and  TTX,  but  can be easily configured to work with any
  15. editor with arexx capabilities.
  16.  
  17. From  the main window you can build complex MUI variables by using a
  18. series  of  Listviews.  When complete, click OK or SEND and the word
  19. will be returned to your editor and inserted at the cursor position.
  20. There  are  various  other  methods  for returning a word, see later
  21. text.
  22.  
  23. MUI-Prefs
  24. ---------
  25. In  order  to make the program pop-up on your current editors screen
  26. it needs to have a public screen and the Screen Prefs need to to set
  27. to «Frontmost» using the MUI Preferences program.
  28.  
  29. (CED  needs  to  be  set  to  use  a  public  screen by changing the
  30. "Environment/Rendering Choices" settings)
  31.  
  32. CED usage:
  33. ----------
  34. Assign a key to the arexx program: getstring-ced.rexx.
  35. MetaMac  can  be  used to do this quickly, or use (Left Amiga)-M and
  36. choose  a  key  to  bind the Arexx Macro to. When editing, press the
  37. macro-key  and  up will pop the MUI-Lists window. Build the word you
  38. want by choosing the various parts from the listviews. The word that
  39. will be used is shown underneath the listviews.
  40.  
  41. IMPORTANT:
  42. The  arexx script  "getstring-XXX.rexx"  needs  customising to  your
  43. environment by changing the muifile statement.
  44.  
  45.  
  46. The GUI
  47. -------
  48.  
  49. The user interface is made up of:
  50.  
  51. - Heading
  52.  
  53.    This is just to let everyone know who wrote the program :)
  54.  
  55.  
  56. - Four Listviews
  57.  
  58.    From  these you can build up the text that you'd rather not type.
  59. As  all  MUI  text  is made up of upto four parts, only the relevant
  60. listviews  will  be  available  for  choosing  from.  Each  part  is
  61. activated by a single click and opens as many listviews as needed.
  62.  
  63.  
  64. - Text Line
  65.  
  66.    This  shows  the  text  being  built  up.
  67.  
  68.  
  69. - Buttons OK, Send, Quit & Cancel
  70.  
  71.   OK     - Clicking OK will cause the built up word to be  sent back
  72.            to  arexx,  and then  from  there it  can be  sent to the
  73.            editor via the getstring-XXX.rexx program.
  74.  
  75.   SEND   - This is similar to OK but leaves the  window open  on the
  76.            screen so  that more  words can be sent without having to
  77.            re-open the window.
  78.  
  79.   Quit   - Quit  is  the  same  as  Cancel, but it  also removes the
  80.            MUILISTS port from memory.
  81.  
  82.   Cancel - Cancel returns nothing, but leaves the port in memory.
  83.  
  84. The  word  can  also  be  returned  by  double-clicking  within  the
  85. list-views.   This   is   the  same  as  using  the  'Send'  button.
  86. Double-clicking returns the word currently in the text gadget.
  87.  
  88. A cycle chain also exists, so that options can be chosen by <tab>ing
  89. between the listviews and button gadgets, and using the cursor keys
  90. to choose the elements of the returned string.
  91.  
  92. When  the  string  is  returned  via one of the various methods, the
  93. arexx  script  parses  the  returned string and forwards it onto the
  94. specified  editor through the arexx port. The script then decides if
  95. you wanted to keep the window open or not.
  96.  
  97.  
  98. Arexx Commands
  99. --------------
  100.  
  101. Apart  from  the usual commands available to all MUI Apps, MUI-Lists
  102. knows one more command, "getstring". This opens the MUI-Lists window
  103. and returns the string chosen via Arexx.
  104.  
  105.  
  106. Running from the CLI or WorkBench
  107. ---------------------------------
  108.  
  109. As  MUI-Lists  is  useless  without  an  Arexx port, running it from
  110. either  of  these  options will simply open a port called "MUILISTS"
  111. which  will  wait for input from arexx. You can start it from either
  112. WBStartup,  or  enter a line in your user-startup however neither of
  113. these is really neccessary as the arexx script will run the file and
  114. wait for the port to appear anyway.
  115.  
  116.  
  117. Quiting MUI-Lists
  118. ------------------
  119.  
  120. To  quit  the  program,  and  release it from memory, either run the
  121. arexx program quit.rexx or type the following in a shell:
  122.                     rx "address 'MUILISTS'; 'quit'"
  123.  
  124.  
  125. About the author
  126. ----------------
  127.  
  128. I can be contacted at anytime by e-mail as:
  129.                     mfishera@cix.compulink.co.uk
  130. This  is  my first MUI project, and as I really find it easy to use,
  131. I'll try and write many more (work, Debbie & CIX permitting :)
  132.  
  133. This  program  is  released  as  FreeWare, you don't have to send me
  134. anything to use it, but abuse & suggestions are welcome :)
  135.  
  136. Thanks to the following people for suggestions and help,
  137.  
  138. 1. Me :)                              2. Richard "Debugger" Waspe
  139. 3. Michael "Demon 68000" Walter       4. Stephen "Need any GFX?" Loughran
  140. 5. Ian Moran                          6. Eric Totel
  141.  
  142. Thanks  also  to  Mike  for the TTX script, Richard for the Enforcer
  143. hits  and  help in curing them, and Eric for various suggestions and
  144. MUIBuilder.
  145.  
  146. Disclaimer :(
  147. ----------
  148.  
  149.    THERE  IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
  150. APPLICABLE   LAW.  EXCEPT  WHEN  OTHERWISE  STATED  IN  WRITING  THE
  151. COPYRIGHT  HOLDER  AND/OR  OTHER PARTIES PROVIDE THE PROGRAM "AS IS"
  152. WITHOUT   WARRANTY   OF  ANY  KIND,  EITHER  EXPRESSED  OR  IMPLIED,
  153. INCLUDING,   BUT   NOT   LIMITED   TO,  THE  IMPLIED  WARRANTIES  OF
  154. MERCHANTABILITY  AND  FITNESS  FOR  A PARTICULAR PURPOSE. THE ENTIRE
  155. RISK  AS  TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.
  156. SHOULD  THE  PROGRAM  PROVE  DEFECTIVE,  YOU  ASSUME THE COST OF ALL
  157. NECESSARY SERVICING, REPAIR OR CORRECTION.
  158.  
  159.    IN  NO  EVENT  UNLESS  REQUIRED BY APPLICABLE LAW OR AGREED TO IN
  160. WRITING  WILL  ANY  COPYRIGHT  HOLDER,  OR  ANY  OTHER PARTY WHO MAY
  161. REDISTRIBUTE  THE  PROGRAM  AS PERMITTED ABOVE, BE LIABLE TO YOU FOR
  162. DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL
  163. DAMAGES  ARISING  OUT  OF  THE  USE  OR INABILITY TO USE THE PROGRAM
  164. (INCLUDING  BUT  NOT  LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
  165. INACCURATE  OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE
  166. OF  THE  PROGRAM  TO  OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH
  167. HOLDER  OR  OTHER  PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  168. DAMAGES.
  169.  
  170. I really hate to say all that, but basically as Prince says (sic!)
  171.                  "In this life, You're on your own"
  172.  
  173. Have fun and I hope this program is useful.
  174.